<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.scheduler;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.bukkit.plugin.Plugin;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.concurrent.Callable;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.concurrent.Future;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.List;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    public interface BukkitScheduler {<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>        /**<a name="line.10"></a>
<FONT color="green">011</FONT>         * Schedules a once off task to occur after a delay<a name="line.11"></a>
<FONT color="green">012</FONT>         * This task will be executed by the main server thread<a name="line.12"></a>
<FONT color="green">013</FONT>         *<a name="line.13"></a>
<FONT color="green">014</FONT>         * @param Plugin Plugin that owns the task<a name="line.14"></a>
<FONT color="green">015</FONT>         * @param Runnable Task to be executed<a name="line.15"></a>
<FONT color="green">016</FONT>         * @param long Delay in server ticks before executing task<a name="line.16"></a>
<FONT color="green">017</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.17"></a>
<FONT color="green">018</FONT>         */<a name="line.18"></a>
<FONT color="green">019</FONT>        public int scheduleSyncDelayedTask(Plugin plugin, Runnable task, long delay);<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>        /**<a name="line.21"></a>
<FONT color="green">022</FONT>         * Schedules a once off task to occur as soon as possible<a name="line.22"></a>
<FONT color="green">023</FONT>         * This task will be executed by the main server thread<a name="line.23"></a>
<FONT color="green">024</FONT>         *<a name="line.24"></a>
<FONT color="green">025</FONT>         * @param Plugin Plugin that owns the task<a name="line.25"></a>
<FONT color="green">026</FONT>         * @param Runnable Task to be executed<a name="line.26"></a>
<FONT color="green">027</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.27"></a>
<FONT color="green">028</FONT>         */<a name="line.28"></a>
<FONT color="green">029</FONT>        public int scheduleSyncDelayedTask(Plugin plugin, Runnable task);<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>        /**<a name="line.31"></a>
<FONT color="green">032</FONT>         * Schedules a repeating task<a name="line.32"></a>
<FONT color="green">033</FONT>         * This task will be executed by the main server thread<a name="line.33"></a>
<FONT color="green">034</FONT>         *<a name="line.34"></a>
<FONT color="green">035</FONT>         * @param Plugin Plugin that owns the task<a name="line.35"></a>
<FONT color="green">036</FONT>         * @param Runnable Task to be executed<a name="line.36"></a>
<FONT color="green">037</FONT>         * @param long Delay in server ticks before executing first repeat<a name="line.37"></a>
<FONT color="green">038</FONT>         * @param long Period in server ticks of the task<a name="line.38"></a>
<FONT color="green">039</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.39"></a>
<FONT color="green">040</FONT>         */<a name="line.40"></a>
<FONT color="green">041</FONT>        public int scheduleSyncRepeatingTask(Plugin plugin, Runnable task, long delay, long period);<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>        /**<a name="line.43"></a>
<FONT color="green">044</FONT>         * Schedules a once off task to occur after a delay<a name="line.44"></a>
<FONT color="green">045</FONT>         * This task will be executed by a thread managed by the scheduler<a name="line.45"></a>
<FONT color="green">046</FONT>         *<a name="line.46"></a>
<FONT color="green">047</FONT>         * @param Plugin Plugin that owns the task<a name="line.47"></a>
<FONT color="green">048</FONT>         * @param Runnable Task to be executed<a name="line.48"></a>
<FONT color="green">049</FONT>         * @param long Delay in server ticks before executing task<a name="line.49"></a>
<FONT color="green">050</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        public int scheduleAsyncDelayedTask(Plugin plugin, Runnable task, long delay);<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>        /**<a name="line.54"></a>
<FONT color="green">055</FONT>         * Schedules a once off task to occur as soon as possible<a name="line.55"></a>
<FONT color="green">056</FONT>         * This task will be executed by a thread managed by the scheduler<a name="line.56"></a>
<FONT color="green">057</FONT>         *<a name="line.57"></a>
<FONT color="green">058</FONT>         * @param Plugin Plugin that owns the task<a name="line.58"></a>
<FONT color="green">059</FONT>         * @param Runnable Task to be executed<a name="line.59"></a>
<FONT color="green">060</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        public int scheduleAsyncDelayedTask(Plugin plugin, Runnable task);<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /**<a name="line.64"></a>
<FONT color="green">065</FONT>         * Schedules a repeating task<a name="line.65"></a>
<FONT color="green">066</FONT>         * This task will be executed by a thread managed by the scheduler<a name="line.66"></a>
<FONT color="green">067</FONT>         *<a name="line.67"></a>
<FONT color="green">068</FONT>         * @param Plugin Plugin that owns the task<a name="line.68"></a>
<FONT color="green">069</FONT>         * @param Runnable Task to be executed<a name="line.69"></a>
<FONT color="green">070</FONT>         * @param long Delay in server ticks before executing first repeat<a name="line.70"></a>
<FONT color="green">071</FONT>         * @param long Period in server ticks of the task<a name="line.71"></a>
<FONT color="green">072</FONT>         * @return int Task id number (-1 if scheduling failed)<a name="line.72"></a>
<FONT color="green">073</FONT>         */<a name="line.73"></a>
<FONT color="green">074</FONT>        public int scheduleAsyncRepeatingTask(Plugin plugin, Runnable task, long delay, long period);<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /**<a name="line.76"></a>
<FONT color="green">077</FONT>         * Calls a method on the main thread and returns a Future object<a name="line.77"></a>
<FONT color="green">078</FONT>         * This task will be executed by the main server thread<a name="line.78"></a>
<FONT color="green">079</FONT>         *<a name="line.79"></a>
<FONT color="green">080</FONT>         * Note:  The Future.get() methods must NOT be called from the main thread<a name="line.80"></a>
<FONT color="green">081</FONT>         * Note2: There is at least an average of 10ms latency until the isDone() method returns true<a name="line.81"></a>
<FONT color="green">082</FONT>         *<a name="line.82"></a>
<FONT color="green">083</FONT>         * @param Plugin Plugin that owns the task<a name="line.83"></a>
<FONT color="green">084</FONT>         * @param Callable Task to be executed<a name="line.84"></a>
<FONT color="green">085</FONT>         * @return Future Future object related to the task<a name="line.85"></a>
<FONT color="green">086</FONT>         */<a name="line.86"></a>
<FONT color="green">087</FONT>        public &lt;T&gt; Future&lt;T&gt; callSyncMethod(Plugin plugin, Callable&lt;T&gt; task);<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>        /**<a name="line.89"></a>
<FONT color="green">090</FONT>         * Removes task from scheduler<a name="line.90"></a>
<FONT color="green">091</FONT>         *<a name="line.91"></a>
<FONT color="green">092</FONT>         * @param int Id number of task to be removed<a name="line.92"></a>
<FONT color="green">093</FONT>         */<a name="line.93"></a>
<FONT color="green">094</FONT>        public void cancelTask(int taskId);<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /**<a name="line.96"></a>
<FONT color="green">097</FONT>         * Removes all tasks associated with a particular plugin from the scheduler<a name="line.97"></a>
<FONT color="green">098</FONT>         *<a name="line.98"></a>
<FONT color="green">099</FONT>         * @param Plugin Owner of tasks to be removed<a name="line.99"></a>
<FONT color="green">100</FONT>         */<a name="line.100"></a>
<FONT color="green">101</FONT>        public void cancelTasks(Plugin plugin);<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>        /**<a name="line.103"></a>
<FONT color="green">104</FONT>         * Removes all tasks from the scheduler<a name="line.104"></a>
<FONT color="green">105</FONT>         */<a name="line.105"></a>
<FONT color="green">106</FONT>        public void cancelAllTasks();<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /**<a name="line.108"></a>
<FONT color="green">109</FONT>         * Check if the task currently running.<a name="line.109"></a>
<FONT color="green">110</FONT>         *<a name="line.110"></a>
<FONT color="green">111</FONT>         * A repeating task might not be running currently, but will be running in the future.<a name="line.111"></a>
<FONT color="green">112</FONT>         * A task that has finished, and does not repeat, will not be running ever again.<a name="line.112"></a>
<FONT color="green">113</FONT>         *<a name="line.113"></a>
<FONT color="green">114</FONT>         * Explicitly, a task is running if there exists a thread for it, and that thread is alive.<a name="line.114"></a>
<FONT color="green">115</FONT>         *<a name="line.115"></a>
<FONT color="green">116</FONT>         * @param taskId The task to check.<a name="line.116"></a>
<FONT color="green">117</FONT>         *<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return If the task is currently running.<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        public boolean isCurrentlyRunning(int taskId);<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>        /**<a name="line.122"></a>
<FONT color="green">123</FONT>         * Check if the task queued to be run later.<a name="line.123"></a>
<FONT color="green">124</FONT>         *<a name="line.124"></a>
<FONT color="green">125</FONT>         * If a repeating task is currently running, it might not be queued now but could be in the future.<a name="line.125"></a>
<FONT color="green">126</FONT>         * A task that is not queued, and not running, will not be queued again.<a name="line.126"></a>
<FONT color="green">127</FONT>         *<a name="line.127"></a>
<FONT color="green">128</FONT>         * @param taskId The task to check.<a name="line.128"></a>
<FONT color="green">129</FONT>         *<a name="line.129"></a>
<FONT color="green">130</FONT>         * @return If the task is queued to be run.<a name="line.130"></a>
<FONT color="green">131</FONT>         */<a name="line.131"></a>
<FONT color="green">132</FONT>        public boolean isQueued(int taskId);<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>        /**<a name="line.134"></a>
<FONT color="green">135</FONT>         * Returns a list of all active workers.<a name="line.135"></a>
<FONT color="green">136</FONT>         *<a name="line.136"></a>
<FONT color="green">137</FONT>         * This list contains asynch tasks that are being executed by separate threads.<a name="line.137"></a>
<FONT color="green">138</FONT>         *<a name="line.138"></a>
<FONT color="green">139</FONT>         * @return Active workers<a name="line.139"></a>
<FONT color="green">140</FONT>         */<a name="line.140"></a>
<FONT color="green">141</FONT>        public List&lt;BukkitWorker&gt; getActiveWorkers();<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>        /**<a name="line.143"></a>
<FONT color="green">144</FONT>         * Returns a list of all pending tasks.  The ordering of the tasks is not related to their order of execution.<a name="line.144"></a>
<FONT color="green">145</FONT>         *<a name="line.145"></a>
<FONT color="green">146</FONT>         * @return Active workers<a name="line.146"></a>
<FONT color="green">147</FONT>         */<a name="line.147"></a>
<FONT color="green">148</FONT>        public List&lt;BukkitTask&gt; getPendingTasks();<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>    }<a name="line.150"></a>




























































</PRE>
</BODY>
</HTML>
